/*
 * Copyright 2011 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package compiler.api.a1;

import compiler.impl.p1.FunctionDescr;

/**
 *  A descriptor builder for functions
 */
public interface FunctionDescrBuilder
    extends
    DescrBuilder<PackageDescrBuilder, FunctionDescr>,
    ParameterSupportBuilder<FunctionDescrBuilder> {

    /**
     * Sets an alternate namespace for the function
     * 
     * @param namespace
     * 
     * @return itself
     */
    public FunctionDescrBuilder namespace(String namespace);

    /**
     * Sets function name
     * 
     * @param name
     * 
     * @return itself
     */
    public FunctionDescrBuilder name(String name);

    /**
     * Sets function return type
     * 
     * @param type
     * 
     * @return itself
     */
    public FunctionDescrBuilder returnType(String type);

    /**
     * Sets the function body
     * 
     * @param body
     * 
     * @return itself
     */
    public FunctionDescrBuilder body(String body);

    /**
     * Sets the function dialect. Default is java.
     * 
     * @param dialect
     * 
     * @return itself
     */
    public FunctionDescrBuilder dialect(String dialect);
}
